home *** CD-ROM | disk | FTP | other *** search
/ Internet Info 1994 March / Internet Info CD-ROM (Walnut Creek) (March 1994).iso / networking / terms / kermit / c / fl2ker.sty < prev    next >
Encoding:
Text File  |  1988-08-16  |  33.2 KB  |  385 lines

  1. ,* Last update 13 July 1985
  2. ,ju
  3. ,lm 5
  4. ,ll 72
  5. ,pl 66
  6. ,hd
  7. ,ll 60
  8. ,tf
  9.  
  10. KERMIT-09 User
  11. s guide
  12.  
  13.  
  14. ,,
  15. ,pg
  16. ,ft
  17. ,ll 60
  18.  
  19. ,ce 1
  20. - ## -
  21.  
  22. ,,
  23. ,ce 2
  24. FLEX-09 KERMIT
  25. --------------
  26.  
  27.  
  28.  
  29.  
  30. ,nj
  31.  
  32. Author:    Jur van der Burg
  33.     
  34. Nettelhorst 56
  35.     
  36. 2402 LS    Alphen aan den Rijn
  37.     
  38. The Netherlands
  39. Language:    C (Compiled with Introl (c) compiler)
  40. Version:    3.0
  41. Date:
  42.     July 1986
  43.  
  44.  
  45.  
  46.  
  47. ,ju
  48. KERMIT for FLEX has it's roots in the UNIX version. It is enhanced in
  49.  several ways, such as data logging, server mode etc.
  50.  
  51. It should run on about any version
  52.  of the FLEX-09 (tm) or SK*DOS (tm) operating system. It requires 48K of memory. Hardware d
  53. ependent things are kept in the files FLK.H and FLIO.C .
  54.  
  55. FLEX-09 KERMIT has most of the 
  56. features specified in the KERMIT Protocol Manual.
  57. ,pg
  58. 1. Remote and Local Operation
  59.  
  60. ,i
  61. n 5
  62. KERMIT programs can be run in two ways, remote and local. A remote Kermit is usually r
  63. unning on a mainframe, which you have CONNECTed to through a PC or other computer. When KER
  64. MIT runs remotely, all file transfer is done over the job's controlling terminal line -- th
  65. e same line over which you logged in, and to which you would type interactive commands. Wha
  66. t the system thinks is your terminal is really another computer, usually a microcomputer, r
  67. unning its own copy of Kermit.
  68.  
  69. When KERMIT is in "local mode", file transfer is done ove
  70. r an external device, such as a microcomputer's serial communication port, or an assigned t
  71. erminal line on a mainframe. The local Kermit is connected in some way (like a dialout mech
  72. anism) to another computer, again running its own copy of Kermit. A local Kermit is in cont
  73. rol of the screen, a remote Kermit has no direct access to it.
  74.  
  75. Microcomputer KERMITs usu
  76. ally run in local "mode", whereas mainframe Kermits usually need to be given some special c
  77. ommand to run in local mode. Some commands make sense only for remote Kermits, others only 
  78. for local, still others can be used with either. Local and remote operation of KERMIT is sh
  79. own schematically here:
  80.  
  81. ,in 0
  82.  Micro is Local, Mainframe is Remote:
  83.  
  84.  
  85.     
  86. Communicatio
  87. n Line     (Packets)
  88.      +-------------------/    /-----------------+    Other terminals
  89.      !    (!    !    !    !
  90.      !
  91.     (!    !    !    !
  92.     Micro    !    LOCAL    Mainframe    !    !    !    !    REMOTE
  93.  +
  94. ----------+----------+    +------------+--+--+--+--------+
  95.  !    Serial Port    !    !     !    !
  96.  !    !    !     !    
  97. !
  98.  !    !    !     !    !
  99.  !    +---------------+    !    !     Your job's    !
  100.  !    ! Packets: 724
  101.     !    !    !     terminal line    !
  102.  !    !    !    !    !    !
  103.  !    ! File: FOO.BAR !
  104.     !    !    !
  105.  !    +---------------+    !    !    !
  106.  !    Screen     !    !    !
  107.  !    !    !    !
  108.  
  109.  +---------------+-----+    +------------------------------+
  110.     !
  111.     ! (Commands)
  112.     !
  113.     +------------+---------+
  114.     \    Keyboard    
  115. \
  116.     +----------------------+
  117.     You
  118. ,pg
  119. ,in 5
  120. The KERMIT program on the micro is a local Kermit. It ca
  121. n control the screen, the keyboard, and the port separately, thus it can update the screen 
  122. with status information, watch for interrupt signals from the keyboard, and transfer packet
  123. s on the communications port, all at the same time.
  124.  
  125. The KERMIT program running on the ma
  126. inframe is a remote Kermit. The user logs in to the mainframe through a terminal port. The 
  127. host computer cannot tell that the user is really coming in through a microcomputer. The ke
  128. yboard, screen, and port functions are all combined in user's mainframe terminal line. Ther
  129. efore a remote Kermit is cut off from your screen and keyboard during file transfer.
  130.  
  131. A K
  132. ERMIT server is always remote, and must get its commands from a local KERMIT. The following
  133.  descriptions will indicate when a command must be remote or local.
  134.  
  135. ,in 0
  136. 2. Command In
  137. terface
  138.  
  139. ,in 5
  140. The FLEX-09 implementation has an interactive keyword-style command inter
  141. face, modeled after that of the DEC VAX/VMS operating system, which is roughly as follows:
  142.  
  143.  
  144. In response to the "Kermit-xx>" prompt you may type a keyword, such as SEND, RECEIVE, o
  145. r EXIT, possibly followed by additional keywords or operands, each of which is called a fie
  146. ld. You can abbreviate keywords (but not file names) to any length that makes them distingu
  147. ishable from any other keyword valid for that field. The command is terminated by a carriag
  148. e return. Before the carriage return is typed, the command can be edited using RUBOUT or ot
  149. her command editing keys. Finally, the same command is entered again with a minimum of keys
  150. trokes, with each field abbreviated to its shortest unique length.
  151.  
  152. ,in 0
  153. 3. Notation
  154.  
  155.  
  156. ,in 5
  157. In the command descriptions, the following notation is used:
  158.  
  159. anything
  160. ,in 15
  161.  
  162. A parameter - the symbol is replaced by an argument of the specified type (number, filena
  163. me, etc).
  164.  
  165. ,in 5
  166. [anything]
  167. ,in 15
  168. An optional field. If omitted, it defaults to an a
  169. ppropriate value.
  170.  
  171. ,in 5
  172. number
  173. ,in 15
  174. A whole number, entered in hexadecimal or decim
  175. al notation.
  176.  
  177. ,in 5
  178. character
  179. ,in 15
  180. A single character, entered literally, or as a nu
  181. mber (perhaps decimal or hexadecimal) representing the ASCII value of the character.
  182.  
  183. ,in
  184.  5
  185. file-spec
  186. ,in 15
  187. A file specification, i.e. the name of a file, possibly including a 
  188. drive number or other qualifying information, and possibly containing "wildcard" or pattern
  189. -matching characters to denote a group of files.
  190.  
  191. ,in 5
  192. ^X
  193. ,in 15
  194. A control character 
  195. may be written using "uparrow" or "caret" notation, since many systems display control char
  196. acters this way. Control characters are produced by holding down the key marked CTRL or Con
  197. trol and typing the appropriate character, e.g. X.
  198.  
  199. ,in 5
  200. Commands are shown in upper ca
  201. se, but can be entered in any combination of upper and lower case.
  202.  
  203. ,in 0
  204. 4. Summary of 
  205. KERMIT Commands
  206.  
  207. ,in 5
  208. Here is a brief list of KERMIT commands as they are found in the 
  209. FLEX-09 KERMIT program. The following sections will describe these commands in detail.
  210.  
  211. ,
  212. in 5
  213. For exchanging files:
  214.     SEND, RECEIVE, GET
  215.  
  216. For connecting to a remote host:
  217.     
  218. CONNECT, SET LINE, SET CONFIGURATION, SET BAUD, SET DUPLEX,
  219.     SET HANDSHAKE, SET ESCAP
  220. E, SET PROMPT, SET LOG
  221.  
  222. For acting as a server:
  223.     SERVER
  224.  
  225. For talking to a server:
  226.     BYE, FINISH, GET, SEND
  227.  
  228. Setting nonstandard transmission and file parameters:
  229.     SE
  230. T BLOCK_CHECK_TYPE, SET DEBUG, SET DELAY, SET FILETYPE,
  231.     SET INCOMPLETE, SET WARNING, S
  232. ET CONFIGURATION, SET RETRY,
  233.     SET END_OF_LINE, SET START_OF_PACKET, SET PACKET_LENGTH,
  234.  
  235.     SET TIMEOUT, SET PADDING, SET PADCHAR, SET QUOTE,
  236.     SET REPEAT_QUOTE, SET EIGHT_BI
  237. T_QUOTE, TAKE
  238.  
  239. For interrupting transmission:
  240.     Control-X, Control-Z
  241.  
  242. Getting inform
  243. ation:
  244.     HELP, STATISTICS, SHOW, Control-D
  245.  
  246. For recording the history of a file transf
  247. er operation:
  248.     SET DEBUG LOG
  249.  
  250. For non-protocol file capture or transmission:
  251.     SET
  252.  LOG, TRANSMIT
  253.  
  254. Leaving the program:
  255.     EXIT, QUIT
  256.  
  257. If you have a file called KERMIT.
  258. INI in your default or home disk, KERMIT will execute an automatic TAKE command on it upon 
  259. initial startup. KERMIT.INI may contain any KERMIT commands, for instance SET commands to c
  260. onfigure KERMIT to various systems or communications media.
  261.  
  262. ,in 0
  263. 5. The SEND Command
  264.  
  265.  
  266. ,si 3
  267. Syntax: SEND filespec [filespec2] [filspec3...]
  268.  
  269. ,in 5
  270. The SEND command cause
  271. s a file or file group to be sent to the other system. The filespec may contain the commonl
  272. y used wild-card characters '*' and/or '?', where '*' stands for a string match (including 
  273. null) and '?' stands for a single character match. Use of wildcard characters is the most c
  274. ommon method of indicating a group of files in a single file specification. For instance if
  275.  FOO.BAS is a single file, a BASIC program named FOO, then *.BAS might be a group of BASIC 
  276. programs. If filespec1 contains wildcard characters then all matching files will be sent, i
  277. n directory-listing order by name. If a file can't be opened for read access, it will be sk
  278. ipped. There may be a total of twenty files or file groups specified.
  279.  
  280. ,si -2
  281. SEND Comma
  282. nd General Operation
  283.  
  284.  
  285. Files will be sent with their filename and filetype (for instance F
  286. OO.BAR, no device or directory field, no generation number or attributes). If communication
  287.  line parity is being used (see SET CONFIGURATION), the sending KERMIT will request that th
  288. e other KERMIT accept a special kind of prefix notation for binary files. This is an advanc
  289. ed feature, and not all KERMITs have it; if the other KERMIT does not agree to use this fea
  290. ture, binary files cannot be sent correctly.
  291.  
  292. ,si -2
  293. SEND Remote Operation
  294.  
  295.  
  296. If you are
  297.  running KERMIT remotely (for instance, from a microcomputer), you should "escape back" to 
  298. your local Kermit within a reasonable amount of time and give the RECEIVE command. Don't ta
  299. ke more than about one minute to complete the switch, or KERMIT may "time out" and give up 
  300. (in that case, you'll have to CONNECT back to the remote system and reissue the SEND comman
  301. d).
  302.  
  303. ,si -2
  304. SEND Local Operation
  305.  
  306.  
  307. If you're running KERMIT locally, for instance on a 
  308. microcomputer, you should have already run KERMIT on the remote system and issued either a 
  309. RECEIVE or a SERVER command.
  310.  
  311. Once you give KERMIT the SEND command, the name of each fil
  312. e will be printed on your screen as the transfer begins, and information will be displayed 
  313. to indicate the packet traffic. When the specified operation is complete, the program will 
  314. sound a beep, and the status of the operation will be indicated by the message Complete, In
  315. terrupted, or Failed.
  316.  
  317. If you see many packet retry indications, you are probably sufferi
  318. ng from a noisy connection. You may be able to cut down on the retransmissions by using SET
  319.  PACKET_LENGTH to decrease the packet length; this will reduce the probability that a given
  320.  packet will be corrupted by noise, and reduce the time required to retransmit a corrupted 
  321. packet. If you notice a file being sent which you do not really want to send, you may cance
  322. l the operation immediately by typing either Control-X or Control-Z. If your are sending a 
  323. file group, Control-X will cause the current file to be skipped, and KERMIT will go on to t
  324. he next file, whereas Control-Z will cancel sending the entire group and return you to KERM
  325. IT-09 command level.
  326.  
  327. ,in 0
  328. 6. The RECEIVE Command
  329.  
  330. ,si 3
  331. Syntax:    RECEIVE [filespe
  332. c]
  333.  
  334. ,in 5
  335. The RECEIVE command tells KERMIT to wait for the arrival a file or file group 
  336. sent by a SEND command from the other system. If only one file is being received, you may i
  337. nclude the optional filespec as the name to store the incoming file under; otherwise, the n
  338. ame is taken from the incoming file header. If the name in the header is not a legal file n
  339. ame on the local system, KERMIT will attempt to transform it to a legal name. If an incomin
  340. g file has the same name as an existing file, KERMIT will either overwrite the old file or 
  341. else try to create a new unique name, depending on the setting of FILE WARNING.
  342.  
  343. If you h
  344. ave SET CONFIGURATION with parity, then 8th-bit prefixing will be requested. If the other s
  345. ide cannot do this, binary files cannot be transferred correctly. The sending KERMIT may al
  346. so request that repeated characters be compressed.
  347.  
  348. If an incoming file does not arrive i
  349. n its entirety, KERMIT will normally discard it; it will not appear in your directory. You 
  350. may change this behavior by using the command SET INCOMPLETE KEEP, which will cause as much
  351.  of the file as arrived to be saved in your directory.
  352.  
  353. ,si -2
  354. RECEIVE Remote Operation
  355.  
  356.  
  357.  
  358. If your are running KERMIT remotely, you should escape back to your local Kermit and gi
  359. ve the SEND command. You should do this within about one minute, or KERMIT may time out and
  360.  give up; if this happens, you can CONNECT back to the remote system and reissue the RECEIV
  361. E command.
  362.  
  363. ,si -2
  364. RECEIVE Local Operation
  365.  
  366.  
  367. If you are running KERMIT locally, you sho
  368. uld already have issued a SEND command to the remote KERMIT, and then escaped back to KERMI
  369. T-09 (not SERVER -- use the GET command to receive files from a KERMIT server).
  370.  
  371. As files
  372.  arrive, their names will be shown on your screen, along with a continuous display the pack
  373. et traffic.
  374.  
  375. If a file begins to arrives that you don't really want, you can attempt to c
  376. ancel it by typing Control-X; this sends a cancellation request to the remote Kermit. If th
  377. e remote Kermit understands this request (not all implementations of Kermit support this fe
  378. ature), it will comply; otherwise it will continue to send. KERMIT-09 will detect this situ
  379. ation and send an error packet. If a file group is being sent, you can request the entire g
  380. roup be cancelled by typing Control-Z.
  381.  
  382.  
  383. ,in 0
  384. 7. GET
  385.  
  386. ,si 3
  387. LOCAL ONLY -- Syntax: GET
  388.  remote-filespec [filespec2...]
  389.  
  390. ,in 5
  391. The GET command requests a remote KERMIT server t
  392. o send the file or file group specified by remote-filespec. Note the distinction between th
  393. e RECEIVE and GET commands: RECEIVE puts KERMIT into a passive wait state, whereas GET acti
  394. vely sends a command to a server.
  395.  
  396. The GET command can be used only when KERMIT is local,
  397.  with a KERMIT server on the other end of the line. This means that you must have CONNECTed
  398.  to the other system, logged in, run KERMIT there, issued the SERVER command, and escaped b
  399. ack to the local KERMIT.
  400.  
  401. The remote filespec is any string that can be a legal file spec
  402. ification for the remote system; it is not parsed or validated locally. As files arrive, th
  403. eir names will be displayed on your screen, along with a continuous indication of the packe
  404. t traffic. As in the RECEIVE command, you may type Control-X to request that the current in
  405. coming file be cancelled, Control-Z to request that the entire incoming batch be cancelled.
  406.  
  407.  
  408. If the remote KERMIT is not capable of server functions, then you will probably get an 
  409. error message back from it like "Illegal packet type". In this case, you must connect to th
  410. e other Kermit, give a SEND command, escape back, and give a RECEIVE command.
  411.  
  412. ,in 0
  413. 8. 
  414. SERVER
  415.  
  416. ,si 3
  417. Syntax: SERVER
  418.  
  419. ,in 5
  420. The SERVER command instructs KERMIT to cease taki
  421. ng commands from the keyboard and to receive all further instructions in the form of KERMIT
  422.  packets from another system. A KERMIT server must be remote; that is, you must be logged i
  423. n to the system through another computer, such as a microcomputer. In addition, your local 
  424. KERMIT should have commands for communicating with remote servers; these include GET, FINIS
  425. H, and BYE.
  426.  
  427. After issuing this command, escape back to your local system and issue SEND,
  428.  GET, BYE, FINISH, or other server-oriented commands from there. If your local KERMIT does 
  429. not have a BYE command, then it does not have the full ability to communicate with a KERMIT
  430.  server and you should not put the remote KERMIT into SERVER mode. If your local KERMIT doe
  431. s have a BYE command, use it to shut down and log out the KERMIT server when you are done w
  432. ith it. The KERMIT-09 server can also be shutdown by typing Control-X or Control-Z. Then th
  433. e server will stop after the timeout.
  434.  
  435. Any nonstandard parameters should be selected with
  436.  SET commands before putting KERMIT in server mode, in particular the block check type and 
  437. special file modes.
  438.  
  439. ,in 0
  440. 9. BYE
  441.  
  442. ,si 3
  443. LOCAL ONLY -- Syntax: BYE
  444.  
  445. ,in 5
  446. When ru
  447. nning as a local Kermit talking to a KERMIT server, use the BYE command to shut down and lo
  448. g out the server. This will also close any debugging log files and exit from the local KERM
  449. IT.
  450.  
  451. ,in 0
  452. 10. FINISH
  453.  
  454. ,si 3
  455. LOCAL ONLY -- Syntax: FINISH
  456.  
  457. ,in 5
  458. When running as a
  459.  local Kermit talking to a remote KERMIT server use the FINISH command to shut down the ser
  460. ver without logging out the remote job, so that you can CONNECT back to it.
  461.  
  462. ,in 0
  463. 11. F
  464. LEX
  465.  
  466. ,si 3
  467. Syntax: FLEX command
  468.  
  469. ,in 5
  470. Execute the specified command on the local sys
  471. tem -- on the system where KERMIT to which your are typing this command is running. These c
  472. ommands provide some local file management capability without having to leave the KERMIT pr
  473. ogram, which is particularly useful on microcomputers. Be sure that the programs you run re
  474. side in the utility command space ($C100 - $C6FF).
  475.  
  476. FLEX DELETE filespec    Delete the sp
  477. ecified file or files.
  478.  
  479. FLEX CAT [filespec]    Provide a directory listing of the specifi
  480. ed
  481.     files.
  482.  
  483. ,in 0
  484. 12. CONNECT
  485.  
  486. ,si 3
  487. LOCAL ONLY -- Syntax: CONNECT [terminal-desi
  488. gnator]
  489.  
  490. ,in 5
  491. Establish a terminal connection to the system at the other end of the co
  492. mmunication line. On a microcomputer, this is normally the serial port. On a mainframe, you
  493.  will have to specify a terminal line number or other identifier, either in the CONNECT co
  494. mmand itself, or in a SET LINE command. If a log file was opened (see SET LOG) then the dat
  495. a will be buffered in memory, which will be written to disk if it becomes full. Handshaking
  496.  is provided (see SET HANDSHAKE). Get back to the local KERMIT by typing the escape charact
  497. er followed by a single character "command".
  498. ,pg
  499. Several single-character commands are po
  500. ssible:
  501.  
  502.     C    Close the connection and return to the local KERMIT.
  503.     H    Show ava
  504. ilability.
  505.     S    Show status of the connection.
  506.     B    Send a BREAK signal.
  507.     0    
  508. (zero) Send a NUL (0) character.
  509.     Q    Quit logging session transcript.
  510.     R    Res
  511. ume logging session transcript.
  512.     ?    List all the possible single-character arguments.
  513.  
  514.     ^    (or whatever you have set the escape character to be)
  515.         Typing the escape cha
  516. racter twice sends one copy of it
  517.         to the connected host.
  518.     other    Rings the bell.
  519.  
  520.  
  521. You can use the SET ESCAPE command to define a different escape character, and SET CONF
  522. IGURATION, SET BAUD, SET DUPLEX, SET HANDSHAKE to establish or change those parameters.
  523.  
  524. ,in 0
  525. 13. HELP
  526.  
  527. ,si 3
  528. Syntax: HELP [subject] [sub-subject]
  529.  
  530. ,in 5
  531. Typing HELP alone 
  532. prints a brief summary of KERMIT and its commands. Help about a particular topic can be obt
  533. ained by giving it as a parameter. The HELP data file will be searched on the drive KERMIT-
  534. 09 was loaded from.
  535.  
  536. ,in 0
  537. 14. EXIT, QUIT
  538.  
  539. ,si 3
  540. Syntax: EXIT
  541.     or:    QUIT
  542.  
  543. ,in
  544.  5
  545. Exit from KERMIT. QUIT is a synonym for EXIT. If a log file was used with CONNECT, and 
  546. the buffer still contains data, then the buffer will we written to disk before terminating 
  547. KERMIT-09.
  548.  
  549. ,in 0
  550. 15. The SET Command
  551.  
  552. ,si 3
  553. Syntax: SET parameter [option] [value]
  554.  
  555.  
  556. ,in 5
  557. Establish or modify various parameters for file transfer or terminal connection.
  558.  
  559.  
  560. When a file transfer operation begins, the two KERMITs automatically exchange special i
  561. nitialization messages, in which each program provides the other with certain information a
  562. bout itself. This information includes the maximum packetsize it wants to receive, the time
  563. out interval it wants the other KERMIT to use, the number and type of padding characters it
  564.  needs, the end-of-line character it needs to terminate each packet (if any), the block che
  565. ck type, the desired prefixes for control characters, characters with the "high bit" set, a
  566. nd repeated characters. Each KERMIT program has its own preset "default" values for these p
  567. arameters, and you normally need not concern yourself with them. You can examine their valu
  568. es with the SHOW command; the SET command is provided to allow you to change them in order 
  569. to adapt to unusual conditions.
  570.  
  571. The following parameters may be SET:
  572.  
  573. ,in 7
  574. BAUD    
  575. S
  576. et the speed of the current communications port
  577. BLOCK_CHECK_TYPE Packet transmission error
  578.  detection method
  579. CONFIGURATION    Character parity to use
  580. DEBUG     Mode or log file
  581. DEL
  582. AY     How long to wait before starting to send
  583. DUPLEX     For terminal connection, full (re
  584. mote echo) or
  585.     half (local echo)
  586. EIGHT_BIT_QUOTE    Character to use for binary file t
  587. ransfer if
  588.     parity used
  589. END_OF_LINE    End of line character
  590. ESCAPE     Character for 
  591. terminal connection
  592. FILETYPE        For setting ascii or binary file type.
  593. HANDSHAKE    Selec
  594. ting flow control characters, like XON/XOFF
  595. INCOMPLETE    What to do with an incomplete fi
  596. le
  597. LINE    
  598. Terminal line to use for terminal connection or
  599.     file transfer
  600. LOG    CONN
  601. ECTion logging file
  602. PACKET_LENGTH    Length of a packet
  603. PADDING    
  604. Number of padding char
  605. acters
  606. PADCHAR    
  607. Padding character
  608. PROMPT     Prompt of the local KERMIT
  609. QUOTE     Charac
  610. ter used to transfer control characters
  611. REPEAT_QUOTE    Character to use for data compress
  612. ion
  613. RETRY     How many times to retry a packet before give up
  614. START_OF_PACKET    Start of 
  615. packet character
  616. TIMEOUT    
  617. Time to wait for a packet
  618. WARNING    
  619. File conflict warning fl
  620. ag
  621.  
  622.  
  623. ,in 2
  624. SET BAUD
  625.  
  626. ,si 1
  627. Syntax: SET BAUD number
  628.  
  629. ,in 5
  630. Set or change the baud ra
  631. te (approximate translation: transmission speed in bits per second) on the currently select
  632. ed communications device. In simple FLEX systems the only allowable baud-rates are 300 and 
  633. 1200. Other interfaces may provide a complete range.
  634.  
  635. ,in 2
  636. SET BLOCK_CHECK_TYPE
  637.  
  638. ,si 
  639. 1
  640. Syntax: SET BLOCK_CHECK_TYPE number
  641.  
  642. ,in 5
  643. KERMIT normally uses a 1-character block c
  644. heck, or "checksum", on each packet. The sender of the packet computes the block check base
  645. d on the other characters in the packet, and the receiver recomputes it the same way. If th
  646. ese quantities agree, the packet is accepted and the transmission proceeds. If they disagr
  647. ee, the packet is rejected and transmitted again.
  648.  
  649. However, the block check is not a fool
  650. proof method of error detection. The normal single-character KERMIT block check is only a 6
  651. -bit quantity (the low order 8 bits of the arithmetic sum folded upon itself). With only si
  652. x bits of accuracy, the chances are one     6
  653. in 2    -- that is, 1/64 -- that an error can
  654.  occur which will not be detected in the checksum, assuming that all errors are equally lik
  655. ely.
  656.  
  657. You can decrease the probability that an error can slip through, at the expense of 
  658. transmission efficiency, by using the SET BLOCK_CHECK_TYPE command to select more rigorous 
  659. block check methods. Note that all three methods will detect any single-bit error, or any e
  660. rror in an odd number of bits.
  661.  
  662. The options are:
  663.  
  664. ,in 7
  665. 1-CHARACTER-CHECKSUM:
  666.  
  667. ,in 1
  668. 5
  669. The normal single-character 6-bit checksum.
  670.  
  671. ,in 7
  672. 2-CHARACTER-CHECKSUM:
  673.  
  674. ,in 15
  675. A
  676.  2-character, 12-bit checksum. Reduces the probability of an error going undetected to 1/40
  677. 96, but adds an extra character to each packet.
  678.  
  679. ,in 7
  680. 3-CHARACTER-CRC:
  681.  
  682. ,in 15
  683. A 3-c
  684. haracter, 16-bit Cyclic Redundancy Check, CCITT format. In addition to errors in any odd nu
  685. mber of bits, this method detects double bit errors, all error bursts of length 16 or less,
  686.  and more than 99.99% of all possible longer bursts. Adds two extra characters to each pack
  687. et.
  688.  
  689. ,in 5
  690. The single character checksum has proven to be quite adequate in practice, mu
  691. ch more effective than straightforward analysis would indicate, since all errors are not eq
  692. ually likely, and a simple checksum is well suited to catching the kinds of errors that are
  693.  typical of telecommunication lines. The other methods should be requested only when the co
  694. nnection is very noisy.
  695.  
  696. Note that the 2- and 3-character block checks are not available 
  697. in all versions of KERMIT; if the other KERMIT is not capable of performing the higher-prec
  698. ision block checks, the transfer will automatically use the standard single-character metho
  699. d.
  700.  
  701. ,in 2
  702. SET DEBUG
  703.  
  704. ,si 1
  705. Syntax: SET DEBUG options [file]
  706.  
  707. ,in 5
  708. Record the pack
  709. et traffic, either on your terminal or in a file. Options are:
  710.  
  711. ON    Display each incomi
  712. ng and outgoing packet
  713.     (lengthy).
  714.  
  715. OFF    
  716. Don't display debugging information (this 
  717. is the
  718.     default). If debugging was in effect, turn it off
  719.     and close any open debug
  720.  log file.
  721.  
  722. LOG    
  723. Log the information to the specified file.
  724.  
  725. During data transfer, de
  726. bugging can be toggled on and off by pressing Control-D. If a log file was opened, it will 
  727. be closed.
  728.  
  729. ,in 2
  730. SET DELAY
  731.  
  732. ,si 1
  733. Syntax: SET DELAY number
  734.  
  735. ,in 5
  736. Specify how man
  737. y seconds to wait before sending the first packet after a SEND command. Use when remote and
  738.  SENDing files back to your local Kermit. This gives you time to "escape" back and issue a 
  739. RECEIVE command. The normal delay is 5 seconds. In local mode or server mode, KERMIT does n
  740. ot delay before sending the first packet.
  741.  
  742. ,in 2
  743. SET DUPLEX
  744.  
  745. ,si 1
  746. Syntax: SET DUPLEX
  747.  keyword
  748.  
  749. ,in 5
  750. For use when CONNECTed to a remote system. The keyword choices are FULL 
  751. and HALF. FULL means the remote system echoes the characters you type, HALF means the local
  752.  system echoes them. FULL is the default, and is used by most hosts. HALF is necessary when
  753.  connecting to IBM mainframes. Half duplex is also called "local echo".
  754.  
  755. ,in 2
  756. SET ESCAP
  757. E
  758.  
  759. ,si 1
  760. Syntax: SET ESCAPE character
  761.  
  762. ,in 5
  763. Specify or change the character you want
  764.  to use to "escape" from remote connections back to KERMIT. This would normally be a charac
  765. ter you don't expect to be using on the remote system, perhaps a control character like ^[,
  766.  ^], ^^, or ^_. KERMIT-09 uses the up-arrow ('^') by default. After you type the escape cha
  767. racter, you must follow it by a single-character "argument", such as "C" for Close Connecti
  768. on. The arguments are listed above, under the description of the CONNECT command.
  769.  
  770. ,in 2
  771.  
  772. SET FILETYPE
  773.  
  774. ,si 1
  775. Syntax: SET FILETYPE parameter
  776.  
  777. ,in 5
  778. Establish file-related pa
  779. rameter. This may be either ASCII for text files or BINARY for non-text files. This is a ve
  780. ry important command if you intend to transfer binary files, but is normally unnecessary fo
  781. r transmitting textual files.
  782.  
  783. ,in 2
  784. SET HANDSHAKE
  785.  
  786. ,si 1
  787. Syntax: SET HANDSHAKE start
  788.  stop
  789.  
  790. ,in 5
  791. For communicating with full duplex systems. System-level flow control is no
  792. t necessary to the KERMIT protocol, but it can help to use it if the same method is availab
  793. le on both systems. The most common type of flow control on full duplex systems is XON/XOFF
  794. . If the KERMIT input buffer is filled up to 250 characters, the stop character is sent. If
  795.  the buffer becomes empty and contains only 10 characters, the start character will be send
  796. . The defaults for start is XON (17), and for stop XOFF (19).
  797.  
  798. ,nl 5
  799. ,in 2
  800. SET INCOMPLE
  801. TE
  802.  
  803. ,si 1
  804. Syntax: SET INCOMPLETE option
  805.  
  806. ,in 5
  807. Specify what to do when a file transfe
  808. r fails before it is completed. The options are DISCARD (the default) and KEEP. If you choo
  809. se KEEP, then if a transfer fails to complete successfully, you will be able to keep the in
  810. complete part that was received.
  811.  
  812. ,in 2
  813. SET LINE
  814.  
  815. ,si 1
  816. Syntax: SET LINE terminal-des
  817. ignator
  818.  
  819. ,in 5
  820. Specify the terminal line to use for file transfer or CONNECT. This comma
  821. nd is found on mainframe KERMITs, which normally run in "remote mode" using their own contr
  822. olling terminal for file transfer. Specifying a separate line puts the program in "local mo
  823. de". If the line is specified as 'REMOTE', the communication will revert to the job's contr
  824. olling terminal.
  825.  
  826. ,in 2
  827. SET CONFIGURATION
  828.  
  829. ,si 1
  830. Syntax: SET CONFIGURATION number
  831.  
  832. ,in 5
  833. Parity is a technique used by communications equipment for detecting errors on a per
  834. -character basis; the "8th bit" of each character acts as a check bit for the other seven b
  835. its. KERMIT uses block checks to detect errors on a per-packet basis, and it does not use c
  836. haracter parity. However, some systems that KERMIT runs on, or equipment through which thes
  837. e systems communicate, may be using character parity. If KERMIT does not know about this, a
  838. rriving data will have been modified and the block check will appear to be wrong, and packe
  839. ts will be rejected.
  840.  
  841. If parity is being used on the communication line, you must inform 
  842. both KERMITs, so the desired parity can be added to outgoing characters, and stripped from 
  843. incoming ones. SET CONFIGURATION should be used for communicating with hosts that require c
  844. haracter parity (IBM mainframes are typical examples) or through devices or networks that a
  845. dd parity to characters that pass through them. Both KERMITs should be set to the same pari
  846. ty. The specified configuration parity is used both for terminal connection (CONNECT) and f
  847. ile transfer (SEND, RECEIVE, GET).
  848.  
  849. The choices for SET CONFIGURATION are:
  850.  
  851. ,in 7
  852. 0.    
  853. Seven data bits, even parity and two stop bits.
  854. 1.    Seven data bits, odd parity and tw
  855. o stop bits.
  856. 2.    Seven data bits, even parity and one stop bit.
  857. 3.    Seven data bits, 
  858. odd parity and one stop bit.
  859. 4.    Eight data bits, no parity and two stop bits.
  860. 5.    Ei
  861. ght data bits, no parity and one stop bit (default).
  862. 6.    Eight data bits, even parity an
  863. d one stop bit.
  864. 7.    Eight data bits, odd parity and one stop bit.
  865.  
  866. ,in 5
  867. Eight bits m
  868. eans no parity is affecting the data, and the 8th bit of each character can be used for dat
  869. a when transmitting binary files.
  870.  
  871. If you have set to use parity then advanced versions o
  872. f KERMIT (including KERMIT-09) will request that binary files will be transferred using 8th
  873. -bit-prefixing. If the KERMIT on the other side knows how to do 8th-bit-prefixing (this is 
  874. an optional feature of the KERMIT protocol, and not all implementations of KERMIT have it),
  875.  then binary files can be transmitted successfully. If eight-bits communication is specifie
  876. d, 8th-bit-prefixing will not be requested.
  877.  
  878. ,in 2
  879. SET EIGHT_BIT_QUOTE
  880.  
  881. ,si 1
  882. Syntax:
  883.  SET EIGHT_BIT_QUOTE character
  884.  
  885. ,in 5
  886. What character to use to process eight_bit bytes o
  887. ver a line using only seven data bits. The sending KERMIT will ask the other KERMIT whether
  888.  it can handle a special prefix encoding for characters with
  889. the eighth bit on, using the 
  890. eight_bit_quote character. This character should be distinct from the REPEAT_QUOTE characte
  891. r and the QUOTE character. The default is "&" (38). There should be no reason to change thi
  892. s.
  893.  
  894. ,in 2
  895. SET END_OF_LINE
  896.  
  897. ,si 1
  898. Syntax: SET END_OF_LINE character
  899.  
  900. ,in 5
  901. The ASC
  902. II character to be used as a line terminator for packets, if one is required by the other s
  903. ystem, carriage return by default. You will only have to use this command for systems that 
  904. require a line terminator other than carriage return. The character must be specified as a 
  905. hexadecimal number.
  906.  
  907. ,in 2
  908. SET LOG
  909.  
  910. ,si 1
  911. Syntax: SET LOG filespec
  912.  
  913. ,in 5
  914. Create a
  915.  transcript of a CONNECT session, when running a local KERMIT connected to a remote system,
  916.  in the specified file. Logging can be "toggled" by typing the connect escape character fo
  917. llowed by Q (Quit logging) or R (Resume logging). Session-logging is useful for recording d
  918. ialog with an interactive system, and for "capturing" from systems that don't have KERMIT. 
  919. No guarantee can be made that the file will arrive correctly or completely, since no error 
  920. checking takes place. The log file will be closed if the filespec is a dash ("-").
  921.  
  922. ,in 2
  923.  
  924. SET PACKET_LENGTH
  925.  
  926. ,si 1
  927. Syntax: SET PACKET_LENGTH number
  928.  
  929. ,in 5
  930. Maximum packet len
  931. gth to send between 10 and 94 (decimal). Shortening the packets might allow more of them to
  932.  get through through without error on noisy communication lines. Lengthening the packets in
  933. creases the throughput on clean lines.
  934.  
  935. ,in 2
  936. SET TIMEOUT
  937.  
  938. ,si 1
  939. Syntax: SET TIMEOUT 
  940. number
  941.  
  942. ,in 5
  943. How many seconds to wait for a packet before trying again.
  944.  
  945. ,in 2
  946. SET P
  947. ADDING
  948.  
  949. ,si 1
  950. Syntax: SET PADDING number
  951.  
  952. ,in 5
  953. How much padding to send before a pac
  954. ket, if the other side needs
  955. padding. Default is no padding.
  956.  
  957. ,in 2
  958. SET PADCHAR
  959.  
  960. ,si 
  961. 1
  962. Syntax: SET PADCHAR character
  963.  
  964. ,in 5
  965. What kind of padding character to send. Default 
  966. is NUL (0). The character must be specified as a hexadecimal number.
  967.  
  968. ,in 2
  969. SET QUOTE
  970.  
  971.  
  972. ,si 1
  973. Syntax: SET QUOTE character
  974.  
  975. ,in 5
  976. What printable character to use for quotin
  977. g of control characters. This character should be distinct from the EIGHT_BIT_QUOTE charact
  978. er and the REPEAT_QUOTE character. The default is "#" (35). There should be no reason to c
  979. hange this.
  980.  
  981. ,in 2
  982. SET REPEAT_QUOTE
  983.  
  984. ,si 1
  985. Syntax: SET REPEAT_QUOTE character
  986.  
  987. ,in 
  988. 5
  989. What character to use to process repeat count characters. The sending KERMIT will ask th
  990. e other KERMIT whether it can handle a special prefix encoding for repeated characters, usi
  991. ng the repeat_quote character. This character should be distinct from the EIGHT_BIT_QUOTE c
  992. haracter and the QUOTE character. The default is "~" (126). There should be no reason to c
  993. hange this.
  994.  
  995. ,in 2
  996. SET RETRY
  997.  
  998. ,si 1
  999. Syntax: SET RETRY number
  1000.  
  1001. ,in 5
  1002. Set the maximu
  1003. m number of retries for how many times to try sending a particular packet before giving up,
  1004.  normally 10. If a line is very noisy, you might want to increase this number.
  1005.  
  1006. ,in 2
  1007. SE
  1008. T START_OF_PACKET
  1009.  
  1010. ,si 1
  1011. Syntax: SET START_OF_PACKET character
  1012.  
  1013. ,in 5
  1014. The start-of-pa
  1015. cket character is the only control character used "bare" by the KERMIT protocol. It is Cont
  1016. rol-A by default. If a bare Control-A causes problems for your communication hardware or so
  1017. ftware, you can use this command to select a different control character to mark the start 
  1018. of a packet. You must also set the start_of_packet character at the KERMIT on the other sys
  1019. tem (providing it has such a command). The character must be specified as a hexadecimal num
  1020. ber.
  1021. ,nl 5
  1022. ,in 2
  1023. SET WARNING
  1024.  
  1025. ,si 1
  1026. Syntax: SET WARNING keyword
  1027.  
  1028. ,in 5
  1029. Enable or d
  1030. isable the warning if an incoming file already exists, where the keyword must be either ON 
  1031. or OFF. When set to ON (the default) and an incoming file already exists, an attempt will b
  1032. e made to store the file under a new and unique name. When set to OFF, an existing file wi
  1033. ll be overwritten.
  1034.  
  1035. ,in 0
  1036. 16. SHOW
  1037.  
  1038. ,si 3
  1039. Syntax: SHOW option
  1040.  
  1041. ,in 5
  1042. The SHOW comm
  1043. and displays the values of the parameters settable by the SET command. If the option is ALL
  1044. , then a complete display will be provided.
  1045.  
  1046. ,in 0
  1047. 17. STATISTICS
  1048.  
  1049. ,si 3
  1050. Syntax: STAT
  1051. ISTICS
  1052.  
  1053. ,in 5
  1054. Give statistics about the most recent file transfer, such as the total num
  1055. ber of characters transmitted, the effective baud rate (only if a hardware clock is availab
  1056. le), and so forth.
  1057.  
  1058. ,in 0
  1059. 18. TAKE
  1060.  
  1061. ,si 3
  1062. Syntax: TAKE filespec
  1063.  
  1064. ,in 5
  1065. Execute KER
  1066. MIT commands from the specified file. The file may contain any valid KERMIT commands, inclu
  1067. ding other TAKE commands.
  1068.  
  1069. ,in 0
  1070. 19. TRANSMIT
  1071.  
  1072. ,si 3
  1073. Syntax: TRANSMIT filespec
  1074.  
  1075. ,in
  1076.  5
  1077. Send the contents of the specified file to the other system "bare", without protocol, p
  1078. ackets, error checking, or retransmission. This command is useful for sending standard logo
  1079. n or connection sequences, or to send commands to a smart modem, or for sending files to sy
  1080. stems that don't have KERMIT. No guarantee can be made that the target system will receive 
  1081. the file correctly and completely. When receiving a file, the target system would normally 
  1082. be running a text editor in text collection mode. The tranferred data will be displayed on 
  1083. the screen if DEBUG is on.
  1084.